<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>ProctorTicket.Wrapper</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="ProctorTicket-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/proctorticket">ProctorTicket</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="ProctorTicket-module.html">Package&nbsp;ProctorTicket</a> ::
        Module&nbsp;Wrapper
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="ProctorTicket.Wrapper-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module Wrapper</h1><span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html">source&nbsp;code</a></span><br /><br />
ProctorTicket.Wrapper The library which holds together 
  ProctorTicket.Trac and ProctorTicket.Proctor, enabling a result to be 
  turned into a ticket and added to the database. This module contains 
  cmdParser, an option parser instance for the command line interface. It 
  also contains a function, makeSense, for grabbing all the info from the 
  parsed arguments and returning a TracDBConnection instance, along with a 
  dictionary of settings.<br /><br />

<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmpOptions"></a><span class="summary-sig-name">cmpOptions</span>(<span class="summary-sig-arg">opt1</span>,
        <span class="summary-sig-arg">opt2</span>)</span><br />
      cmpOptions(&lt;optparse.Option&gt;, &lt;optparse.Option&gt;): 
      Comparison function for options which just compares them by their 
      long option names.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#cmpOptions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="ProctorTicket.Wrapper-module.html#ProcessOptions" class="summary-sig-name">ProcessOptions</a>(<span class="summary-sig-arg">arguments</span>=<span class="summary-sig-default">None</span>)</span><br />
      ProcessOptions(arguments=None): Takes the fruit of optparse's 
      efforts and produces two dictionaries, the first with ticket-specific
      settings and the other with general Proctor and environment 
      settings.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#ProcessOptions">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="ProctorTicket.Wrapper-module.html#MakeClasses" class="summary-sig-name">MakeClasses</a>(<span class="summary-sig-arg">ticketDict</span>,
        <span class="summary-sig-arg">optionDict</span>)</span><br />
      MakeClasses(&lt;ticketDict: dictionary&gt;, &lt;optionDict: 
      dictionary&gt;): Creates a Trac.TracDBConn and a Proctor.Test object 
      given a ticketDict and an optionDict, as output from the 
      ProcessOptions function.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#MakeClasses">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="ProctorTicket.Wrapper-module.html#AddTickets" class="summary-sig-name">AddTickets</a>(<span class="summary-sig-arg">DBConn</span>,
        <span class="summary-sig-arg">TestObject</span>,
        <span class="summary-sig-arg">field</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">summary</code><code class="variable-quote">'</code></span>)</span><br />
      AddTickets(&lt;DBConn: Trac.TracDBConn&gt;, &lt;TestObject: 
      Proctor.Test&gt;, &lt;fieldname: string(&quot;summary&quot;)&gt;): 
      Adds the results from TestObject as tickets to DBConn, completing the
      process of migrating Proctor unit tests to Trac tickets.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#AddTickets">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="main"></a><span class="summary-sig-name">main</span>()</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#main">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="cmdParser"></a><span class="summary-name">cmdParser</span> = <code title="optparse.OptionParser()">optparse.OptionParser()</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="ProcessOptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ProcessOptions</span>(<span class="sig-arg">arguments</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#ProcessOptions">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  ProcessOptions(arguments=None): Takes the fruit of optparse's efforts 
  and produces two dictionaries, the first with ticket-specific settings 
  and the other with general Proctor and environment settings. In addition,
  arguments can be specified by setting the 'arguments' keyword argument. 
  If this is not set, then by default sys.argv will be used.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="MakeClasses"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">MakeClasses</span>(<span class="sig-arg">ticketDict</span>,
        <span class="sig-arg">optionDict</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#MakeClasses">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  MakeClasses(&lt;ticketDict: dictionary&gt;, &lt;optionDict: 
  dictionary&gt;): Creates a Trac.TracDBConn and a Proctor.Test object 
  given a ticketDict and an optionDict, as output from the ProcessOptions 
  function. Populates the Test Object with test data, depending on whether 
  there is a log file or a new test needs to be run.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="AddTickets"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">AddTickets</span>(<span class="sig-arg">DBConn</span>,
        <span class="sig-arg">TestObject</span>,
        <span class="sig-arg">field</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">summary</code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ProctorTicket.Wrapper-pysrc.html#AddTickets">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  AddTickets(&lt;DBConn: Trac.TracDBConn&gt;, &lt;TestObject: 
  Proctor.Test&gt;, &lt;fieldname: string(&quot;summary&quot;)&gt;): Adds 
  the results from TestObject as tickets to DBConn, completing the process 
  of migrating Proctor unit tests to Trac tickets. Accepts the keyword 
  argument 'field', which specifies what the unique field should be that is
  used to look up whether or not a particular ticket already exists.
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="ProctorTicket-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/proctorticket">ProctorTicket</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Sat Jan 19 19:26:41 2008
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
